// Copyright (c) Appeon. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

using System;

namespace SnapObjects.Data
{
    /// <summary>
    ///     Denotes that a model class should limit the rows returned.
    /// </summary>
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false, Inherited = true)]
    public class TopAttribute : Attribute
    {
        /// <summary>
        ///     Initializes a new instance of the TopAttribute class.
        /// </summary>
        /// <param name="number">The maximum number of rows to be returned.</param>
        public TopAttribute(int number)
        {
            this.TopRows = number;
        }

        /// <summary>
        ///     Gets the maximum number of rows to be returned.
        /// </summary>
        public int TopRows { get; }
    }
}
